package com.zhengbing.tj.common;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

/**
 * 通用API响应包装类
 * 采用泛型设计实现统一的RESTful API响应格式，支持任意类型的数据封装
 * 用于所有Controller接口的标准化响应，确保前后端数据交互格式一致性
 * 
 * @author zhengbing
 * @date 2025-07-07
 */
@ApiModel("通用响应包装")
public class ApiResult<T> {
    @ApiModelProperty("响应码，200表示成功")
    private int code;
    @ApiModelProperty("响应信息")
    private String message;
    @ApiModelProperty("响应数据")
    private T data;

    public ApiResult() {}

    public ApiResult(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    /**
     * 成功响应，携带数据
     * 创建标准的成功响应，默认消息为"操作成功"
     *
     * @param data 响应数据
     * @param <T> 数据类型
     * @return 成功的ApiResult实例
     */
    public static <T> ApiResult<T> success(T data) {
        return new ApiResult<>(200, "操作成功", data);
    }

    /**
     * 成功响应，携带消息和数据
     * 创建自定义消息的成功响应
     *
     * @param message 成功消息
     * @param data 响应数据
     * @param <T> 数据类型
     * @return 成功的ApiResult实例
     */
    public static <T> ApiResult<T> success(String message, T data) {
        return new ApiResult<>(200, message, data);
    }

    /**
     * 失败响应
     * 创建指定错误码和消息的错误响应
     *
     * @param code 错误码
     * @param message 错误消息
     * @param <T> 数据类型
     * @return 错误的ApiResult实例
     */
    public static <T> ApiResult<T> error(int code, String message) {
        return new ApiResult<>(code, message, null);
    }

    /**
     * 错误响应，携带默认错误码
     * 创建默认500错误码的错误响应
     *
     * @param message 错误消息
     * @param <T> 数据类型
     * @return 错误的ApiResult实例
     */
    public static <T> ApiResult<T> error(String message) {
        return new ApiResult<>(500, message, null);
    }

    /**
     * 失败响应（带数据）
     * 创建包含错误数据的完整错误响应
     *
     * @param code 错误码
     * @param message 错误消息
     * @param data 错误相关数据
     * @param <T> 数据类型
     * @return 错误的ApiResult实例
     */
    public static <T> ApiResult<T> error(int code, String message, T data) {
        return new ApiResult<>(code, message, data);
    }
}